Tangoe Telecom SOAP API

(0 reviews)

APPENDIX A

XSD STRUCTURE

The following appendix contains the detailed structure of the objects used in the previous web methods.

The name spaces used are the same as in the previous XSD documents:

xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.asentinel.com/asentinelws/schemas/invord"
xmlns:tns="http://www.asentinel.com/asentinelws/schemas/invord"

Service Type Object

<xsd:complexType name="ServiceType">
    <xsd:sequence>
        <xsd:element name="id" type="xsd:int"></xsd:element>
        <xsd:element name="description" type="xsd:string"></xsd:element>
        <xsd:element name="majorTypeDescription" type="xsd:string"></xsd:element>
    </xsd:sequence>
</xsd:complexType>

Notes:

majorTypeDescription – represents the type of inventory (voice, data).

Equipment Type, Equipment Manufacturer, Equipment Model Objects

<xsd:complexType name="EquipmentType">
    <xsd:sequence>
        <xsd:element name="id" type="xsd:int" minOccurs="0" maxOccurs="1"></xsd:element>
        <xsd:element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"></xsd:element>
    </xsd:sequence>
</xsd:complexType>
<xsd:complexType name="EquipmentManufacturer">
    <xsd:sequence>
        <xsd:element name="id" type="xsd:int" minOccurs="0" maxOccurs="1"></xsd:element>
        <xsd:element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"></xsd:element>
    </xsd:sequence>
</xsd:complexType>
<xsd:complexType name="EquipmentModel">
    <xsd:sequence>
        <xsd:element name="id" type="xsd:int" minOccurs="0" maxOccurs="1"></xsd:element>
        <xsd:element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"></xsd:element>
    </xsd:sequence>
</xsd:complexType>

Order Type Object

<xsd:complexType name="OrderType">
    <xsd:sequence>
        <xsd:element name="id" type="xsd:int"></xsd:element>
        <xsd:element name="description" type="xsd:string"></xsd:element>
    </xsd:sequence>
</xsd:complexType>

Order Status Object

<xsd:complexType name="OrderStatus">
    <xsd:sequence>
        <xsd:element name="id" type="xsd:int"></xsd:element>
        <xsd:element name="description" type="xsd:string"></xsd:element>
    </xsd:sequence>
</xsd:complexType>

Custom Fields Objects

<xsd:complexType name="CustomFields">
    <xsd:sequence>
        <xsd:element name="customField" type="tns:CustomField" maxOccurs="unbounded" minOccurs="0"></xsd:element>
    </xsd:sequence>
</xsd:complexType>
<xsd:complexType name="CustomField">
    <xsd:sequence>
        <xsd:element name="id" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="name" maxOccurs="1" minOccurs="1">
            <xsd:simpleType>
                <xsd:restriction base="xsd:string">
                    <xsd:minLength value="0"></xsd:minLength>
                    <xsd:maxLength value="30"></xsd:maxLength>
                </xsd:restriction>
            </xsd:simpleType>
        </xsd:element>
        <xsd:element name="value" maxOccurs="1" minOccurs="1">
            <xsd:simpleType>
                <xsd:restriction base="xsd:string">
                    <xsd:minLength value="0"></xsd:minLength>
                    <xsd:maxLength value="500"></xsd:maxLength>
                </xsd:restriction>
            </xsd:simpleType>
        </xsd:element>
        <xsd:element name="fieldType" type="xsd:string" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="required" type="xsd:boolean" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="Options">
        <xsd:sequence>
            <xsd:element name="option" type="tns:Option"
maxOccurs="unbounded" minOccurs="0"></xsd:element>
        </xsd:sequence>
    </xsd:complexType>

<xsd:complexType name="Option">
        <xsd:sequence>
            <xsd:element name="id" type="xsd:int" maxOccurs="1"
minOccurs="1"></xsd:element>
            <xsd:element name="name" type="xsd:string" maxOccurs="1"
minOccurs="1"></xsd:element>
        </xsd:sequence>
</xsd:complexType>

Notes:

CustomFields represents a list of custom field objects. A custom field is defined by CustomField;
According to the schema, the compulsory fields are name and value;
Each custom field value is provided as a string representation of its value;
The name of a custom field is case sensitive.
For “Combo” type custom fields, the available options are included (id – option id, name – option description).

Dynamic Fields Objects

<xsd:complexType name="InventoryColumn">
    <xsd:sequence>
        <xsd:element name="id" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="name" maxOccurs="1" minOccurs="1">
            <xsd:simpleType>
                <xsd:restriction base="xsd:string">
                    <xsd:minLength value="0"></xsd:minLength>
                    <xsd:maxLength value="30"></xsd:maxLength>
                </xsd:restriction>
            </xsd:simpleType>
        </xsd:element>
        <xsd:element name="value" maxOccurs="1" minOccurs="1">
            <xsd:simpleType>
                <xsd:restriction base="xsd:string">
                    <xsd:minLength value="0"></xsd:minLength>
                    <xsd:maxLength value="500"></xsd:maxLength>
                </xsd:restriction>
            </xsd:simpleType>
        </xsd:element>
        <xsd:element name="fieldType" type="xsd:string" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="required" type="xsd:boolean" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:sequence>
</xsd:complexType>
<xsd:complexType name="InventoryDynamicFields">
    <xsd:sequence>
        <xsd:element name="dynamicField" type="tns:InventoryColumn" maxOccurs="unbounded" minOccurs="0"></xsd:element>
    </xsd:sequence>
</xsd:complexType>

Circuit Mapping Objects

<xsd:complexType name="CircuitMappings">
    <xsd:sequence>
        <xsd:element name="circuitMapping" type="tns:CircuitMapping" maxOccurs="unbounded" minOccurs="0"></xsd:element>
    </xsd:sequence>
</xsd:complexType>
<xsd:complexType name="CircuitMapping">
    <xsd:sequence>
        <xsd:element name="id" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="mappedFrom" type="xsd:string" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="fromValue" type="xsd:int" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="mappedTo" type="xsd:string" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="toValue" type="xsd:int" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="cir" maxOccurs="1" minOccurs="1">
            <xsd:simpleType>
                <xsd:restriction base="xsd:string">
                    <xsd:minLength value="0"></xsd:minLength>
                    <xsd:maxLength value="50"></xsd:maxLength>
                </xsd:restriction>
            </xsd:simpleType>
        </xsd:element>
        <xsd:element name="cost" type="xsd:double" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="rangeFrom" type="xsd:double" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="rangeTo" type="xsd:double" maxOccurs="1" minOccurs="1"></xsd:element>
    </xsd:sequence>
</xsd:complexType>

Notes:

CircuitMappings represents a list of circuit mapping objects. A circuit mapping is defined by CircuitMapping;

Split Objects

<xsd:complexType name="SplitItems">
    <xsd:sequence>
        <xsd:element name="splitItem" type="tns:SplitItem" maxOccurs="unbounded" minOccurs="0"></xsd:element>
    </xsd:sequence>
</xsd:complexType>
<xsd:complexType name="SplitItem">
    <xsd:sequence>
        <xsd:element name="costCenterId" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="costCenterNo" type="tns:CostCenterNo" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="percent" type="xsd:double" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="amount" type="xsd:double" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:sequence>
</xsd:complexType>

Notes:

SplitItems represents a list of split components. A split is defined by a SplitItem object;

Operation Result Object

<xsd:complexType name="ActionResult">
    <xsd:all>
        <xsd:element name="code" type="xsd:int" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="message" type="xsd:string" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:all>
</xsd:complexType>

Notes:

Designates the result of an operation, usually the response that is provided;
Code represents an integer that identifies the result of the operation; the convention chose is that a negative error code designates the failure of an operation.
Message represents an optional explication of the result of the operation.

Inventory Details Object

<xsd:complexType name="InventoryDetails">
<xsd:all>
    <xsd:element name="inventoryID" type="xsd:int" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="serviceTypeID" type="xsd:int" maxOccurs="1"
            minOccurs="1"></xsd:element>
    <xsd:element name="inventoryNumber" type="tns:InventoryItemNumber"
            maxOccurs="1" minOccurs="0"></xsd:element>
    <xsd:element name="newInventoryNumber" type="tns:InventoryItemNumber"
         maxOccurs="1" minOccurs="0"></xsd:element>
    <xsd:element name="costCenterNo" type="tns:CostCenterNo" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="glAccount" type="tns:GLAccount" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="address" type="tns:Address" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="city" type="tns:City" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="state" type="tns:State" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="zip" type="tns:Zip" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="country" type="tns:Country" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="locationNo" type="tns:Location"
            maxOccurs="1" minOccurs="0"></xsd:element>
    <xsd:element name="locationZ" type="tns:Location"
            maxOccurs="1" minOccurs="0"></xsd:element>
    <xsd:element name="primaryUse" type="tns:PrimaryUse" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="voiceOrData" type="xsd:boolean" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="vendor" type="tns:Vendor" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="vendorContract" type="tns:VendorContract"
            maxOccurs="1" minOccurs="0"></xsd:element>
    <xsd:element name="ratePlan" type="tns:RatePlan" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="localLDVendor" type="tns:Vendor" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="localLDContract" type="tns:VendorContract"
            maxOccurs="1" minOccurs="0"></xsd:element>
    <xsd:element name="localTollVendor" type="tns:Vendor" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="localTollContract" type="tns:VendorContract"
            maxOccurs="1" minOccurs="0"></xsd:element>
    <xsd:element name="ldLocalVendor" type="tns:Vendor" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="ldLocalContract" type="tns:VendorContract"
            maxOccurs="1" minOccurs="0"></xsd:element>
    <xsd:element name="usageVendor" type="tns:Vendor"
            maxOccurs="1" minOccurs="0"></xsd:element>
    <xsd:element name="usageContract" type="tns:VendorContract"
            maxOccurs="1" minOccurs="0"></xsd:element>
    <xsd:element name="voicePool" type="tns:VoicePool" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="dataPool" type="tns:DataPool" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="messagingPool" type="tns:MessagingPool" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="dateActivated" type="tns:Date" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="dateDeactivated" type="tns:Date" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="assignedTo" type="tns:AssignedTo" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="accountNo" type="tns:AccountNo" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="billingID" type="tns:BillingID" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="status" type="xsd:boolean" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="coLocation" type="tns:Colocation" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="accessID" type="tns:AccessID" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="billingStatus" type="xsd:boolean" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="portSpeed" type="tns:PortSpeed" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="rate" type="tns:PortSpeed" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="accessSpeed" type="tns:AccessSpeed" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="portCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="rackCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="equipmentCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="utilityCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="accessCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="cos" type="tns:COS" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="cosCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="mileageCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="fixedOrUsage" type="xsd:boolean" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="dlci" type="tns:DLCI" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="circuitMappings" type="tns:CircuitMappings"
            maxOccurs="1" minOccurs="0"></xsd:element>
    <xsd:element name="pvcCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="serviceCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="featureCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="piccCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="otherCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="oneTimeCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="advertisingCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="daCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="domesticCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="intCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="usageCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="itemizedCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="coloOtherCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="powerCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="spaceCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="crossConnectCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="supportCharges" type="xsd:double" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="customFields" type="tns:CustomFields" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="comments" type="tns:Comments" maxOccurs="1"
            minOccurs="0"></xsd:element>
    <xsd:element name="lastActionDate" type="tns:Date" maxOccurs="1"
            minOccurs="0"></xsd:element>
</xsd:all>
</xsd:complexType>

Notes:

The inventory fields used inside these objects are defined below;
Based on the serviceTypeID and inventoryNumber the fields used for the operation are identified. Some of the declared fields may not be used for certain service types;
When an inventory item is retrieved the exact structure of the object in accordance with the inventory section of the Telecom application is received;
According to the schema, the only compulsory field is serviceTypeID, but when certain operations are accomplished, other fields are also checked and considered required (e.g. inventoryNumber);
NewInventoryNumber field is used if inventoryNumber of the provided item is modified through an edit operation.
For VOIP, Dark Fiber, Colocation and Ethernet, please check Telecom Web Application for more details on which attributes are significant (used) by each of these service types.

Inventory Log Details Object

<xsd:complexType name="InventoryLogDetails">
    <xsd:all>
        <xsd:element name="inventoryID" type="xsd:int" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="serviceTypeID" type="xsd:int" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="inventoryNumber" type="xsd:string" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="serviceType" type="xsd:string" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="vendor" type="xsd:string" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="modifiedBy" type="xsd:string" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="action" type="xsd:string" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="modificationDate" type="xsd:date" maxOccurs="1" minOccurs="1"></xsd:element>
    </xsd:all>
</xsd:complexType>

Notes:

According to the schema, all fields are compulsory.

Equipment Details Object

<xsd:complexType name="EquipmentDetails">
<xsd:all>
        <xsd:element name="equipmentID" type="xsd:int" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="equipmentTypeID" type="xsd:int" maxOccurs="1"
                  minOccurs="1"></xsd:element>
        <xsd:element name="newEquipmentTypeID" type="xsd:int"
                  maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="deviceName" type="tns:DeviceName"
                  maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="newDeviceName" type="tns:DeviceName"
                  maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="manufacturer" type="tns:Manufacturer"
                  maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="model" type="tns:Model" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="serialNo" type="tns:SerialNo" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="maintenance" type="tns:Maintenance"
                  maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="costCenterNo" type="tns:CostCenterNo"
                  maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="glAccount" type="tns:GLAccount" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="fixedAllocation" type="tns:FixedAllocation"
                  maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="address" type="tns:Address" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="city" type="tns:City" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="state" type="tns:State" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="zip" type="tns:Zip" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="country" type="tns:Country" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="vendor" type="tns:Vendor" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="dateEntered" type="tns:Date" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="dateActivated" type="tns:Date" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="dateDeactivated" type="tns:Date" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="assignedTo" type="tns:AssignedTo"
                  maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="accountNo" type="tns:AccountNo" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="billingID" type="tns:BillingID" maxOccurs="1"
           minOccurs="0"></xsd:element>
        <xsd:element name="status" type="xsd:boolean" maxOccurs="1"
                  minOccurs="0"></xsd:element>
        <xsd:element name="customFields" type="tns:CustomFields"
                  maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="comments" type="tns:Comments" maxOccurs="1"
                  minOccurs="0"></xsd:element>
</xsd:all>
</xsd:complexType>

Notes:

The equipment fields used inside these objects are defined below;
When an equipment is retrieved the exact structure of the object in accordance with the inventory section of the Telecom application is received;
According to the schema, the only compulsory field is equipmentTypeID, but when certain operations are accomplished, other fields are also checked and considered required (e.g. deviceName);
NewEquipmentTypeID field is used if equipmentTypeID of the provided equipment is modified through an edit operation;
NewDeviceName field is used if deviceName of the provided equipment is modified through an edit operation.

Equipment Log Details Object

<xsd:complexType name="EquipmentLogDetails">
    <xsd:all>
        <xsd:element name="equipmentID" type="xsd:int" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="equipmentTypeID" type="xsd:int" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="deviceName" type="xsd:string" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="equipmentType" type="xsd:string" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="vendor" type="xsd:string" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="modifiedBy" type="xsd:string" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="action" type="xsd:string" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="modificationDate" type="tns:Date" maxOccurs="1" minOccurs="1"></xsd:element>
    </xsd:all>
</xsd:complexType>

Notes:

According to the schema, all fields are compulsory.

Order Details Object

<xsd:complexType name="OrderDetails">
    <xsd:all>
        <xsd:element name="orderID" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="orderNumber" type="tns:OrderNumber" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="orderTypeID" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="orderStatusID" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="vendor" type="tns:Vendor" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="serviceTypeID" type="xsd:int" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="deviceTypeID" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="shippingLocation" type="tns:Location" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="dateCreated" type="tns:Date" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="dateSubmitted" type="tns:Date" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="dateCompleted" type="tns:Date" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="dateDue" type="tns:Date" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="orderAccountNo" type="tns:AccountNo" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="customFields" type="tns:CustomFields" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="comments" type="tns:Comments" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="inventoryNumbers" type="tns:InventoryNumbers" maxOccurs="1" minOccurs="1"></xsd:element>
    </xsd:all>
</xsd:complexType>

Notes:

The order fields used inside these objects are defined below;
According to the schema, the compulsory fields are serviceTypeID, inventoryNumbers and orderNumber.
Depending on the operation other fields are compulsory: vendor, deviceTypeID

Edit Order Details Object

<xsd:complexType name="EditOrderDetails">
    <xsd:all>
        <xsd:element name="orderNumber" type="tns:OrderNumber" maxOccurs="1" minOccurs="1"></xsd:element>
        <xsd:element name="orderTypeID" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="orderStatusID" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="dateDue" type="tns:Date" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="dateSubmitted" type="tns:Date" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="dateCompleted" type="tns:Date" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="customFields" type="tns:CustomFields" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="comments" type="tns:Comments" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="shippingLocation" type="tns:Location" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="orderAccountNo" type="tns:AccountNo" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:all>
</xsd:complexType>

Notes:

The order fields used inside these objects are defined below;
According to the schema, the only compulsory field is orderNumber.

Employee Details Object

<xsd:complexType name="EmployeeDetails">
    <xsd:all>
        <xsd:element name="employeeID" type="tns:EIN" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="firstName" type="tns:Name" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="middleInitial" type="tns:MiddleInitial" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="lastName" type="tns:Name" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="status" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="costCenterNo" type="tns:CostCenterNo" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="phoneNumber" type="tns:InventoryItemNumber" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="email" type="tns:Email" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="terminationDate" type="tns:Date" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="terminationDateStart" type="tns:Date" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="terminationDateEnd" type="tns:Date" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="customFields" type="tns:CustomFields" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="reportsTo" type="tns:EIN" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="ccRights" type="tns:CostCenterNos" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="title" type="tns:Title" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:all>
</xsd:complexType>

Notes:

The employee fields used inside these objects are defined below;
From a schema point of view, there are no compulsory fields, but when operations are performed, there are fields that are checked by the server and considered compulsory (e.g. add employee – employeeID, status).

Cost Center Details Object

<xsd:complexType name="CostCenterDetails">
    <xsd:all>
        <xsd:element name="costCenterID" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="costCenterNo" type="tns:CostCenterNo" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="costCenterName" type="tns:Name" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="level1" type="tns:HierarchyLevel" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="level2" type="tns:HierarchyLevel" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="level3" type="tns:HierarchyLevel" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="level4" type="tns:HierarchyLevel" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="level5" type="tns:HierarchyLevel" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="level6" type="tns:HierarchyLevel" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="level7" type="tns:HierarchyLevel" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="level8" type="tns:HierarchyLevel" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="level9" type="tns:HierarchyLevel" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="address" type="tns:Address" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="city" type="tns:City" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="state" type="tns:State" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="zip" type="tns:Zip" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="country" type="tns:Country" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="manager" type="tns:Name" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="phone" type="tns:PhoneNumber" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="fax" type="tns:PhoneNumber" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="email" type="tns:Email" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="totalEmployees" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="phoneLines" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="closed" type="xsd:boolean" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="customFields" type="tns:CustomFields" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="comments" type="tns:Comments" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:all>
</xsd:complexType>

Notes:

The cost center fields used inside these objects are defined below;
From a schema point of view, there are no compulsory fields, but when operations are performed, there are fields that are checked by the server and considered compulsory (e.g. add costCenter – costCenterNo, status).

User Details Object

<xsd:complexType name="UserDetails">
    <xsd:all>
        <xsd:element name="userID" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="userName" type="tns:Name" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="firstName" type="tns:Name" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="lastName" type="tns:Name" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="supportUser" type="tns:Name" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="phoneNumber" type="tns:UserPhoneNumber" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="email" type="tns:Email" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="password" type="tns:Name" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="profileID" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="profileName" type="tns:Name" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:all>
</xsd:complexType>

Notes:

The user fields used inside these objects are defined below;
From a schema point of view, there are no compulsory fields, but when operations are performed, there are fields that are checked by the server and considered compulsory (e.g. add/edit/delete user – userName).

Split Details Object

<xsd:complexType name="SplitDetails">
    <xsd:all>
        <xsd:element name="splitID" type="tns:CostCenterNo" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="splitName" type="tns:Name" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="splitItemsCount" type="xsd:int" maxOccurs="1" minOccurs="0"></xsd:element>
        <xsd:element name="splitItems" type="tns:SplitItems" maxOccurs="1" minOccurs="0"></xsd:element>
    </xsd:all>
</xsd:complexType>

Notes:

The split fields used inside these objects are defined below;
From a schema point of view, there are no compulsory fields, but when operations are performed, there are fields that are checked by the server and considered compulsory (e.g. add split – splitID).

Profile Details Object

<xsd:complexType name="ProfileDetails">
    <xsd:all>
        <xsd:element name="profileID" type="xsd:int" minOccurs="1" maxOccurs="1"></xsd:element>
        <xsd:element name="profileName" type="xsd:string" minOccurs="1" maxOccurs="1"></xsd:element>
        <xsd:element name="profileDescription" type="xsd:string" minOccurs="1" maxOccurs="1"></xsd:element>
        <xsd:element name="builtIn" type="xsd:true" minOccurs="1" maxOccurs="1"></xsd:element>
    </xsd:all>
</xsd:complexType>

Notes:

The profile detail fields used inside these objects are defined below;
From a schema point of view, there are no compulsory fields.

Inventory, Equipment, Order, Employee, Cost Center, User and Split Field Objects

<xsd:simpleType name="InventoryItemNumber">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="50"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="OrderNumber">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="100"></xsd:maxLength>
            <xsd:pattern value="[^(\s"%'`\\)]*"></xsd:pattern>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="DeviceName">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="100"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="Manufacturer">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="100"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="Model">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="100"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="SerialNo">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="100"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="Maintenance">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="100"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="CostCenterNo">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="100"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="Date">
    <xsd:restriction base="xsd:string">
        <xsd:pattern value="(\d{2,2}/\d{2,2}/\d{4,4})?"></xsd:pattern>
    </xsd:restriction>
</xsd:simpleType>

 <xsd:simpleType name="Address">
<xsd:restriction base="xsd:string">
         <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="80"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="City">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="50"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="State">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="2"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="Zip">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="10"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="Country">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="2"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="Comments">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="4000"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="Vendor">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="70"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="VendorContract">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="255"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="RatePlan">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="255"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="VoicePool">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="100"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="DataPool">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="100"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="MessagingPool">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="100"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="AssignedTo">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="50"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="Name">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="50"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="Colocation">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="100"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="PrimaryUse">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="255"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="GLAccount">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="30"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="FixedAllocation">
        <xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="15"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>


<xsd:simpleType name="AccountNo">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="50"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="BillingID">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="4000"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="AccessID">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="4000"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="DLCI">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="20"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="AccessSpeed">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="100"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="PortSpeed">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="12"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="COS">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="200"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="Email">
        <xsd:restriction base="xsd:string">
        <xsd:minLength value="0"></xsd:minLength>
        <xsd:maxLength value="50"></xsd:maxLength>
        <xsd:pattern value=".+@[a-zA-Z\.\d]+\.[a-zA-Z\d]+"></xsd:pattern>
    </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="MiddleInitial">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="2"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="EIN">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="50"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="HierarchyLevel">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="100"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="PhoneNumber">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="13"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:simpleType name="UserPhoneNumber">
<xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="20"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

<xsd:complexType name="InventoryNumbers">
        <xsd:sequence>
        <xsd:element name="inventoryNumber" type="tns:InventoryItemNumber" maxOccurs="unbounded" minOccurs="1"></xsd:element>
        </xsd:sequence>
 </xsd:complexType>

 <xsd:complexType name="InventoryIds">
        <xsd:sequence>
<xsd:element name="inventoryID" type="xsd:int" maxOccurs="unbounded" minOccurs="0"></xsd:element>
        </xsd:sequence>
 </xsd:complexType>

 <xsd:complexType name="CostCenterNos">
        <xsd:sequence>
<xsd:element name="costCenterNo" type="tns:CostCenterNo" maxOccurs="unbounded" minOccurs="0"></xsd:element>
        </xsd:sequence>
 </xsd:complexType>

<xsd:simpleType name="Location">
        <xsd:restriction base="xsd:string">
            <xsd:minLength value="0"></xsd:minLength>
            <xsd:maxLength value="50"></xsd:maxLength>
        </xsd:restriction>
</xsd:simpleType>

APPENDIX A

XSD STRUCTURE

Service Type Object

Equipment Type, Equipment Manufacturer, Equipment Model Objects

Order Type Object

Order Status Object

Custom Fields Objects

Dynamic Fields Objects

Circuit Mapping Objects

Split Objects

Operation Result Object

Inventory Details Object

Inventory Log Details Object

Equipment Details Object

Equipment Log Details Object

Order Details Object

Edit Order Details Object

Employee Details Object

Cost Center Details Object

User Details Object

Split Details Object

Profile Details Object

Inventory, Equipment, Order, Employee, Cost Center, User and Split Field Objects

Reviews